<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>aiengine: xaietile_core.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">aiengine
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xaietile__core_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">xaietile_core.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>Header file for core control and wait functions. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who     Date     Changes
</p>
<hr/>
<p>
1.0  Naresh  04/06/2018  Initial creation
1.1  Naresh  05/07/2018  Fixed CR#1000933
1.2  Naresh  07/11/2018  Updated copyright info and addressed CR#1006573
1.3  Naresh  08/13/2018  Updated prototype for wait done API and also added
                         prototype for core read status done API
1.4  Nishad  12/05/2018  Renamed ME attributes to AIE
</pre> </div><table class="memberdecls">
<tr class="memitem:ae4dac15e0b9705f65eea04ada6a5d684"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__core_8h.html#ae4dac15e0b9705f65eea04ada6a5d684">XAieTile_CoreControl</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr, u8 Enable, u8 Reset)</td></tr>
<tr class="memdesc:ae4dac15e0b9705f65eea04ada6a5d684"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API writes to the Core_control register to enable and/or reset the AIE core of the selected tile.  <a href="#ae4dac15e0b9705f65eea04ada6a5d684">More...</a><br/></td></tr>
<tr class="separator:ae4dac15e0b9705f65eea04ada6a5d684"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a473ea6b25b8feda4144f77ef22a16bf6"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__core_8h.html#a473ea6b25b8feda4144f77ef22a16bf6">XAieTile_CoreWaitStatus</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr, u32 TimeOut, u32 Status)</td></tr>
<tr class="memdesc:a473ea6b25b8feda4144f77ef22a16bf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API implements a blocking wait function to check for the core status to be disabled or done.  <a href="#a473ea6b25b8feda4144f77ef22a16bf6">More...</a><br/></td></tr>
<tr class="separator:a473ea6b25b8feda4144f77ef22a16bf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a218e1570a4a19e45db15d53ee110bd83"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__core_8h.html#a218e1570a4a19e45db15d53ee110bd83">XAieTile_CoreWaitCycles</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr, u32 CycleCnt)</td></tr>
<tr class="memdesc:a218e1570a4a19e45db15d53ee110bd83"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API implements a blocking wait function until the specified clock cyles are elapsed in the Core module 64-bit counter.  <a href="#a218e1570a4a19e45db15d53ee110bd83">More...</a><br/></td></tr>
<tr class="separator:a218e1570a4a19e45db15d53ee110bd83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b9ae87a6b86efc3925794adfcad8da7"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__core_8h.html#a8b9ae87a6b86efc3925794adfcad8da7">XAieTile_CoreReadStatusDone</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr)</td></tr>
<tr class="memdesc:a8b9ae87a6b86efc3925794adfcad8da7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API returns the current value of the Core status done bit.  <a href="#a8b9ae87a6b86efc3925794adfcad8da7">More...</a><br/></td></tr>
<tr class="separator:a8b9ae87a6b86efc3925794adfcad8da7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab081d6a7866ad511e068365e828c88f"><td class="memItemLeft" align="right" valign="top">u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaietile__core_8h.html#aab081d6a7866ad511e068365e828c88f">XAieTile_CoreReadTimer</a> (<a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *TileInstPtr)</td></tr>
<tr class="memdesc:aab081d6a7866ad511e068365e828c88f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This API returns the current value of the Core module 64-bit timer.  <a href="#aab081d6a7866ad511e068365e828c88f">More...</a><br/></td></tr>
<tr class="separator:aab081d6a7866ad511e068365e828c88f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ae4dac15e0b9705f65eea04ada6a5d684"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XAieTile_CoreControl </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Enable</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Reset</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API writes to the Core_control register to enable and/or reset the AIE core of the selected tile. </p>
<p>This API bluntly writes to the register and any gracefullness required in enabling/disabling and/or resetting/unresetting the core are required to be handled by the application layer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr</td><td>- Pointer to the Tile instance. </td></tr>
    <tr><td class="paramname">Enable</td><td>- Enable/Disable the core (1-Enable,0-Disable). </td></tr>
    <tr><td class="paramname">Reset</td><td>- Reset/Unreset the core (1-Reset,0-Unreset).</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_aie_gbl___reg_core_ctrl.html#a8e2b52007595492d1ddc3810e0536362">XAieGbl_RegCoreCtrl::CtrlEn</a>, <a class="el" href="struct_x_aie_gbl___reg_core_ctrl.html#a9d47fc8d52f9f164c1e575b3d1d66832">XAieGbl_RegCoreCtrl::CtrlRst</a>, <a class="el" href="struct_x_aie_gbl___reg_fld_attr.html#a95f0d60188c5baf7612b662f58a98617">XAieGbl_RegFldAttr::Lsb</a>, <a class="el" href="struct_x_aie_gbl___reg_fld_attr.html#a235949ebe8e30fb2b6ee52c0b3c6b760">XAieGbl_RegFldAttr::Mask</a>, <a class="el" href="struct_x_aie_gbl___reg_core_ctrl.html#a0131bd76c99f46d507cff0b4bd7ecdc9">XAieGbl_RegCoreCtrl::RegOff</a>, and <a class="el" href="struct_x_aie_gbl___tile.html#a7c04a73941e64980a264a9d529fbb571">XAieGbl_Tile::TileAddr</a>.</p>

<p>Referenced by <a class="el" href="xsock__clitest_8c.html#a0ddf1224851353fc92bfbff6f499fa97">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a8b9ae87a6b86efc3925794adfcad8da7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAieTile_CoreReadStatusDone </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API returns the current value of the Core status done bit. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr</td><td>- Pointer to the Tile instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Core_Done status bit.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_aie_gbl___reg_core_sts.html#a9f8dc197be0b96dd6eb01d8cc44045d9">XAieGbl_RegCoreSts::Done</a>, <a class="el" href="struct_x_aie_gbl___reg_fld_attr.html#a95f0d60188c5baf7612b662f58a98617">XAieGbl_RegFldAttr::Lsb</a>, <a class="el" href="struct_x_aie_gbl___reg_fld_attr.html#a235949ebe8e30fb2b6ee52c0b3c6b760">XAieGbl_RegFldAttr::Mask</a>, <a class="el" href="struct_x_aie_gbl___reg_core_sts.html#aaf1ffd5d4a0b548f3624dad6443ac627">XAieGbl_RegCoreSts::RegOff</a>, and <a class="el" href="struct_x_aie_gbl___tile.html#a7c04a73941e64980a264a9d529fbb571">XAieGbl_Tile::TileAddr</a>.</p>

</div>
</div>
<a class="anchor" id="aab081d6a7866ad511e068365e828c88f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u64 XAieTile_CoreReadTimer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API returns the current value of the Core module 64-bit timer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr</td><td>- Pointer to the Tile instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>64-bit timer value.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_aie_gbl___reg_timer.html#a1c7f5a4739819fcb7796300771d57c6d">XAieGbl_RegTimer::HighOff</a>, <a class="el" href="struct_x_aie_gbl___reg_timer.html#adc86bc2abd38af25e5fb5c73c8da77bd">XAieGbl_RegTimer::LowOff</a>, and <a class="el" href="struct_x_aie_gbl___tile.html#a7c04a73941e64980a264a9d529fbb571">XAieGbl_Tile::TileAddr</a>.</p>

</div>
</div>
<a class="anchor" id="a218e1570a4a19e45db15d53ee110bd83"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAieTile_CoreWaitCycles </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>CycleCnt</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API implements a blocking wait function until the specified clock cyles are elapsed in the Core module 64-bit counter. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr</td><td>- Pointer to the Tile instance. </td></tr>
    <tr><td class="paramname">CycleCnt</td><td>- No. of timer clock cycles to elapse.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XAIE_SUCCESS on success.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_aie_gbl___reg_timer.html#a1c7f5a4739819fcb7796300771d57c6d">XAieGbl_RegTimer::HighOff</a>, <a class="el" href="struct_x_aie_gbl___reg_timer.html#adc86bc2abd38af25e5fb5c73c8da77bd">XAieGbl_RegTimer::LowOff</a>, and <a class="el" href="struct_x_aie_gbl___tile.html#a7c04a73941e64980a264a9d529fbb571">XAieGbl_Tile::TileAddr</a>.</p>

<p>Referenced by <a class="el" href="xsock__clitest_8c.html#a0ddf1224851353fc92bfbff6f499fa97">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a473ea6b25b8feda4144f77ef22a16bf6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAieTile_CoreWaitStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_aie_gbl___tile.html">XAieGbl_Tile</a> *&#160;</td>
          <td class="paramname"><em>TileInstPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>TimeOut</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This API implements a blocking wait function to check for the core status to be disabled or done. </p>
<p>API comes out of the wait loop when core status changes to done/disable or the timeout elapses, whichever happens first.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TileInstPtr</td><td>- Pointer to the Tile instance. </td></tr>
    <tr><td class="paramname">TimeOut</td><td>- TimeOut in usecs. If set to 0, the default timeout will be set to 500 usecs. </td></tr>
    <tr><td class="paramname">Status</td><td>- 1 for Core_done and 0 for Disable Use macros XAIETILE_CORE_STATUS_DONE/XAIETILE_CORE_STATUS_DISABLE</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The requested status if wait completes successful, or !Status.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_aie_gbl___reg_core_sts.html#a9f8dc197be0b96dd6eb01d8cc44045d9">XAieGbl_RegCoreSts::Done</a>, <a class="el" href="struct_x_aie_gbl___reg_core_sts.html#a59e733d1d00e58e4a807491d569ae9e8">XAieGbl_RegCoreSts::En</a>, <a class="el" href="struct_x_aie_gbl___reg_fld_attr.html#a95f0d60188c5baf7612b662f58a98617">XAieGbl_RegFldAttr::Lsb</a>, <a class="el" href="struct_x_aie_gbl___reg_fld_attr.html#a235949ebe8e30fb2b6ee52c0b3c6b760">XAieGbl_RegFldAttr::Mask</a>, <a class="el" href="struct_x_aie_gbl___reg_core_sts.html#aaf1ffd5d4a0b548f3624dad6443ac627">XAieGbl_RegCoreSts::RegOff</a>, and <a class="el" href="struct_x_aie_gbl___tile.html#a7c04a73941e64980a264a9d529fbb571">XAieGbl_Tile::TileAddr</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
